-
Notifications
You must be signed in to change notification settings - Fork 178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: describe OT2 architecture #6245
Conversation
Codecov Report
@@ Coverage Diff @@
## edge #6245 +/- ##
=======================================
Coverage ? 79.63%
=======================================
Files ? 206
Lines ? 18687
Branches ? 0
=======================================
Hits ? 14881
Misses ? 3806
Partials ? 0
Continue to review full report at Codecov.
|
Wow, thanks so much for this @theosanderson !! This looks like a pretty good, concise overview of the system architecture to me! We'll chat about this when everyone is back in the office on Monday and get back to you with some comments. Thanks again for pulling this together. It's been on the list for a long time 😅 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple small things to change, but this is a great document and I think a good location for it.
Just to make sure this passes CI, please run make format
if you haven't already - we use prettier
to (among other things) enforce consistent styles in markdown documents.
|
|
Co-authored-by: Max Marrone <[email protected]>
Co-authored-by: Max Marrone <[email protected]>
Hey @SyntaxColoring (and @sfoster1 ) , thanks both so much for all of these great changes. As I said at the top I really wouldn't have minded if you rejected the PR entirely so please don't feel under any pressure to take this over what you were already planning! It's great to hear that there was already a plan to pull this together. There's lots of great stuff in that Google doc. I would really like to see here:
I think this PR should now be good for CI. (Let's see). If so I think it could be merged and additional stuff could be part of a future CL when you've had some time to think about details? |
Something else that would be good to document sometime is how calibration works at a high level. My understanding is that deck calibration creates a mapping from deck to smoothie coordinates to adjust for non-squareness, etc. Then pipette calibration makes sure the pipette actually knows where it is in Deck coordinates. Then labware calibration essentially adjusts for errors in the labware definition ? Because labware calibration is not per slot? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Definitely a good start!
Agreed that we should expand it further, but this is absolutely a great start. |
Awesome :) Thanks folks |
Coming into this a bit late (sorry!), but when I first joined Opentrons I made a small doc describing the system architecture as I saw it back then. Ping @SyntaxColoring might be helpful for the doc you're making! I'm also happy to help write up anything about the Protocol Designer side if that's in scope for this project. |
Overview
This is a quick attempt to describe things that might as an outsider have helped me to understand how my OT2 works. The text is clumsy in many ways and I'm sure not comprehensive, but I thought I'd submit the PR on the basis that something is better than nothing, and as a starting point for improvement. I won't be at all offended if you don't agree and want to hold off on this until you have time to sit down and do it properly.
I think things can be quite opaque e.g. "what does the robot server do?" (#6164 (comment)) and that signposting users to the code that is more likely to be relevant to them (API, then buildroot and robot server) as opposed to not (protocol designer, labware designer, etc.) could be helpful.
Intended to fix (in part) #4375.